package cn.levi.dict.annotation;

import cn.levi.dict.configuration.DictSerializer;
import cn.levi.dict.enums.BaseEnum;
import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 该注解用于向前端返回枚举或字典code时自动转化为对应的中文描述
 * 其中枚举定义中必须提供方法：【getNameByValue或者getNameByCode(为了兼容以前的枚举)】参数为integer 返回值为String
 * @author lei
 * @since 2024/9/6
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = DictSerializer.class)
public @interface DictFormat {

	/**
	 * 需要被解析的枚举的类型
	 */
	Class<? extends Enum<?>> value() default  DefaultEnum.class ;

	/**
	 * 需要被解析成的字段，默认为当前字段+Cn
	 */
	String targetFieldName() default "";

	/**
	 * 如果需要从字典中解析，则需要指定该值为字典的code
	 */
	String typeCode() default "";

	/**
	 * 默认值，当无法解析时的默认填充
	 * 未实现，具体原因为：当被注解的字段值为null时，jackson不会使用该注解的序列化，
	 * 尝试使用{@link JsonSerialize#nullsUsing()}来指定为null时的序列化类，难点在：难以指定{@link DictFormat}携带的默认值
	 */
	String defaultValue() default "";
	/**
	 * 无意义，占位
	 */
	enum DefaultEnum{}

}
